/*
 * Open Source Physics software is free software as described near the bottom of this code file.
 *
 * For additional information and documentation on Open Source Physics please see:
 * <http://www.opensourcephysics.org/>
 */

package org.opensourcephysics.tools;

import java.awt.Dimension;
import java.util.List;

import javax.swing.BorderFactory;

/**
 * A FunctionEditor for initial values.
 *
 * @author Douglas Brown
 */
public class InitialValueEditor extends ParamEditor {

	/**
	 * Default constructor
	 */
  public InitialValueEditor(ParamEditor editor) {
  	super();
  	paramEditor = editor;
  	functionPanel = editor.functionPanel;
  }

	/**
	 * Determines if an object's name is editable.
	 * 
	 * @param obj the object
	 * @return always false
	 */
	public boolean isNameEditable(Object obj) {
		return false;
	}
	
	/**
	 * Override getPreferredSize().
	 * 
	 * @return the table size plus button and instruction heights
	 */
	public Dimension getPreferredSize() {
		return table.getPreferredSize();
	}
	
	/**
	 * Evaluates all current objects.
	 */
	public void evaluateAll() {
		super.evaluateAll();
		if (paramValues.length != objects.size()) {
			paramValues = new double[objects.size()];
		}
		List params = paramEditor.getObjects();
		for (int i = 0; i < evaluate.size(); i++) {
			Parameter p = (Parameter)evaluate.get(i);
			p.evaluate(params);
		}
		for (int i = 0; i < objects.size(); i++) {
			Parameter p = (Parameter)objects.get(i);
			paramValues[i] = p.getValue();
		}
	}

  /**
   * Creates the GUI.
   */
	protected void createGUI() {
		super.createGUI();
		remove(buttonPanel);
	}
	
  /**
   * Refreshes the GUI.
   */
  protected void refreshGUI() {
  	super.refreshGUI();
		setBorder(BorderFactory.createTitledBorder(ToolsRes.getString("InitialValueEditor.Border.Title"))); //$NON-NLS-1$
  }
  
  /**
   * Returns a String with the names of variables available for expressions.
   * Only parameter names are available to initial values.
   */
  protected String getVariablesString() {
    StringBuffer vars = new StringBuffer(" "); //$NON-NLS-1$
    int init = vars.length();
  	boolean firstItem = true;
		// add parameters, if any
		String[] paramNames = paramEditor.getNames();
		for (int i = 0; i < paramNames.length; i++) {
      if (!firstItem) vars.append(", "); //$NON-NLS-1$
			vars.append(paramNames[i]);
			firstItem = false;  			
		}
		if (vars.length() == init) 
			return ToolsRes.getString("FunctionPanel.Instructions.Help"); //$NON-NLS-1$
		return ToolsRes.getString("FunctionPanel.Instructions.ValueCell") //$NON-NLS-1$
				+":"+vars.toString(); //$NON-NLS-1$
  }
  
}
	

/*
 * Open Source Physics software is free software; you can redistribute
 * it and/or modify it under the terms of the GNU General Public License (GPL) as
 * published by the Free Software Foundation; either version 2 of the License,
 * or(at your option) any later version.

 * Code that uses any portion of the code in the org.opensourcephysics package
 * or any subpackage (subdirectory) of this package must must also be be released
 * under the GNU GPL license.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston MA 02111-1307 USA
 * or view the license online at http://www.gnu.org/copyleft/gpl.html
 *
 * Copyright (c) 2007  The Open Source Physics project
 *                     http://www.opensourcephysics.org
 */
